home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / tools / vim / doc / vim.man < prev    next >
Text File  |  1995-03-09  |  8KB  |  265 lines
  1.  
  2.  
  3.  
  4. VIM(1)                                                     VIM(1)
  5.  
  6.  
  7. NNAAMMEE
  8.        vim - Vi IMproved, a programmers text editor
  9.  
  10. SSYYNNOOPPSSIISS
  11.        vviimm [options] [file ..]
  12.        vviimm [options] -t tag
  13.        vviimm [options] -e [errorfile]
  14.  
  15. DDEESSCCRRIIPPTTIIOONN
  16.        VViimm  is a text editor that is upwards compatible to vi. It
  17.        can be used to edit any ASCII text. It is especially  use-
  18.        ful for editing programs.
  19.  
  20.        There  are  a  lot  of  enhancements above vi: multi level
  21.        undo, multi windows and  buffers,  command  line  editing,
  22.        filename completion, on-line help, visual selection, etc..
  23.        Read difference.doc  for  a  summary  of  the  differences
  24.        between vi and Vim.
  25.  
  26.        Most  often  VViimm is started to edit a single file with the
  27.        command
  28.  
  29.             vim file
  30.  
  31.        More generally VIM is started with:
  32.  
  33.             vim [options] [filelist]
  34.  
  35.        If the filelist is missing, the editor will start with  an
  36.        empty  buffer.  Otherwise exactly one out of the following
  37.        three may be used to  choose  one  or  more  files  to  be
  38.        edited.
  39.  
  40.        file ..     A list of file names. The first one (alphabet-
  41.                    ically) will be the current file and read into
  42.                    the  buffer.  The cursor will be positioned on
  43.                    the first line of the buffer. You can  get  to
  44.                    the other files with the ":next" command.
  45.  
  46.        -t {tag}    The  file to edit and the initial cursor posi-
  47.                    tion depends on a "tag", a sort of goto label.
  48.                    {tag} is looked up in the tags file, the asso-
  49.                    ciated file becomes the current file  and  the
  50.                    associated command is executed. Mostly this is
  51.                    used for C programs. {tag} then  should  be  a
  52.                    function  name.  The  effect  is that the file
  53.                    containing that function becomes  the  current
  54.                    file and the cursor is positioned on the start
  55.                    of the function  (see  reference.doc,  section
  56.                    "tag searches").
  57.  
  58.        -e [errorfile]
  59.                    Start  in  quickFix mode. The file [errorfile]
  60.                    is read and the first error is  displayed.  If
  61.  
  62.  
  63.  
  64.                           1994 August 12                        1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VIM(1)                                                     VIM(1)
  71.  
  72.  
  73.                    [errorfile]   is  omitted  the  file  name  is
  74.                    obtained from the 'errorfile' option (defaults
  75.                    to  "AztecC.Err"  for  the  Amiga, "errors" on
  76.                    other systems). Further errors can  be  jumped
  77.                    to  with  the ":cn" command. See reference.doc
  78.                    section 5.5.
  79.  
  80. OOPPTTIIOONNSS
  81.        The options, if present, must precede  the  filelist.  The
  82.        options may be given in any order.
  83.  
  84.        -r          Recovery  mode.  The  swap  file  is  used  to
  85.                    recover a crashed editing  session.  The  swap
  86.                    file  is a file with the same file name as the
  87.                    text file with  ".swp"  appended.  See  refer-
  88.                    ence.doc, chapter "Recovery after a crash".
  89.  
  90.        -v          View  mode. The 'readonly' option will be set.
  91.                    You can still edit the  buffer,  but  will  be
  92.                    prevented  from accidently overwriting a file.
  93.                    If you do want to overwrite  a  file,  add  an
  94.                    exclamation  mark  to  the  Ex  command, as in
  95.                    ":w!".  The -v  option  also  implies  the  -n
  96.                    option (see below).  The 'readonly' option can
  97.                    be reset with ":set noro" (see  reference.doc,
  98.                    options chapter).
  99.  
  100.        -b          Binary.  A  few options will be set that makes
  101.                    it possible to edit  a  binary  or  executable
  102.                    file.
  103.  
  104.        +[num]      For  the  first  file the cursor will be posi-
  105.                    tioned on line "num". If "num" is missing, the
  106.                    cursor will be positioned on the last line.
  107.  
  108.        +/pat       For  the  first  file the cursor will be posi-
  109.                    tioned on the first occurrence of  "pat"  (see
  110.                    reference.doc,  section "pattern searches" for
  111.                    the available search patterns).
  112.  
  113.        +{command}
  114.  
  115.        -c {command}
  116.                    {command} will be  executed  after  the  first
  117.                    file  has  been read. {command} is interpreted
  118.                    as an Ex command. If  the  {command}  contains
  119.                    spaces  it  must  be enclosed in double quotes
  120.                    (this depends on  the  shell  that  is  used).
  121.                    Example: Vim "+set si" main.c
  122.  
  123.        -x          (Amiga  only)  Vim  is not restarted to open a
  124.                    new window. This option should  be  used  when
  125.                    Vim  is  executed  by a program that will wait
  126.                    for the edit session to  finish  (e.g.  mail).
  127.  
  128.  
  129.  
  130.                           1994 August 12                        2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VIM(1)                                                     VIM(1)
  137.  
  138.  
  139.                    The ":sh" and ":!" commands will not work.
  140.  
  141.        -o[N]       Open  N  windows.  When N is omitted, open one
  142.                    window for each file.
  143.  
  144.        -n          No swap file will be used.  Recovery  after  a
  145.                    crash will be impossible. Handy if you want to
  146.                    edit a  file  on  a  very  slow  medium  (e.g.
  147.                    floppy).  Can  also  be done with ":set uc=0".
  148.                    Can be undone with ":set uc=200".
  149.  
  150.        -s {scriptin}
  151.                    The script file {scriptin} is read. The  char-
  152.                    acters  in  the file are interpreted as if you
  153.                    had typed them. The same can be done with  the
  154.                    command  ":source!  {scriptin}". If the end of
  155.                    the file is reached before the  editor  exits,
  156.                    further characters are read from the keyboard.
  157.  
  158.        -w {scriptout}
  159.                    All the characters that you type are  recorded
  160.                    in  the  file {scriptout}, until you exit VIM.
  161.                    This is useful if you want to create a  script
  162.                    file to be used with "vim -s" or ":source!".
  163.  
  164.        -T terminal Tells  Vim  the  name  of the terminal you are
  165.                    using. Should  be  a  terminal  known  to  Vim
  166.                    (builtin) or defined in the termcap file.
  167.  
  168.        -d device   Open  "device"  for use as a terminal. Only on
  169.                    the Amiga. Example: "-d con:20/30/600/150".
  170.  
  171. SSEEEE AALLSSOO
  172.        Vim documentation:
  173.  
  174.        reference.doc:
  175.                    A complete reference of Vim (long)
  176.  
  177.        windows.doc:
  178.                    Explanation of the multi windows  and  buffers
  179.                    commands and options
  180.  
  181.        index:      Overview  of  all  command  characters (useful
  182.                    when adding new mappings)
  183.  
  184.        difference.doc:
  185.                    Overview of the differences between vi and Vim
  186.  
  187.        unix.doc:   Unix-specific comments
  188.  
  189.        vim.hlp:    File used by the on-line help (short)
  190.  
  191. AAUUTTHHOORR
  192.        Most of VIM was made by Bram Moolenaar.
  193.  
  194.  
  195.  
  196.                           1994 August 12                        3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. VIM(1)                                                     VIM(1)
  203.  
  204.  
  205.        VIM  is  based on Stevie, worked on by: Tim Thompson, Tony
  206.        Andrews and G.R. (Fred) Walter
  207.  
  208. BBUUGGSS
  209.        Probably.
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                           1994 August 12                        4
  263.  
  264.  
  265.